Documentation and delta-ui update #8
Conversation
There was a problem hiding this comment.
I made some small edits, but I don't seem to have write access :[ Those changes I made are mainly just small clarifications, so I will hold them for now.
- Not a blocker but some things that I'd like to think further
- some frontmatter documentations are in
docs/CONTENT.md, others are indocs/frontmatter. It is well inked, not a problem at all reading the documentation through, but I wonder it won't be convenient to look up later.
| @@ -13,6 +13,9 @@ API_RASTER_ENDPOINT='https://staging-raster.delta-backend.xyz' | |||
| # Endpoint for the STAC server. No trailing slash. | |||
| API_STAC_ENDPOINT='https://staging-stac.delta-backend.xyz' | |||
|
|
|||
| # The mapbox public token obtained from your account | |||
| MAPBOX_TOKEN='pk.eyJ1IjoiY292aWQtbmFzYSIsImEiOiJja2F6eHBobTUwMzVzMzFueGJuczF6ZzdhIn0.8va1fkyaWgM57_gZ2rBMMg' | |||
There was a problem hiding this comment.
Is this safe to commit to the code base? (The repo might be private, but the build will be publicly accessible, right?)
There was a problem hiding this comment.
Yeah, the token is going to be exposed inevitably (user can see it through network request) but Mapbox token can be protected through url restriction (which can be set up through their dashboards.) I can't confirm how this key is set up now, but this is the same one in the ui repo https:/NASA-IMPACT/delta-ui/blob/main/.env#L13 so I don't think it necessarily decreases the safety, but we probably can find a better place for these keys like somewhere in ci pipeline.
There was a problem hiding this comment.
Got it. As long as it's not a security issue I'll merge this and then we can address it later
@hanbyul-here @ricardoduplos Please check that the documentation makes sense and there are no mistakes. Feel free to reword section if they are not clear.
Once this is merged to deploy, the app will be automatically deployed to the surge url.